Skip to main content

List Destinations

Route

/v2/streaming/destinations

Description

Retrieve a list of all streaming destinations configured in your organization. Destinations define where streaming data is sent.

Method

GET

Inputs

ParameterTypeRequiredDescription
None--No parameters required

Output

FieldTypeDescription
resourcesarray[Destination]Array of destination objects
errorsarray[Error]Any errors encountered

Destination Object Structure

FieldTypeDescription
idstringUnique destination identifier
namestringHuman-readable name
descriptionstringDetailed description
formatstringData format (json_lines, json)
typestringDestination type (https)
encodingstringData encoding (gzip, uncompressed)
https_configobjectHTTPS destination configuration

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"resources": [
{
"id": "dest-123",
"name": "Security SIEM",
"description": "Primary security information and event management system",
"format": "json_lines",
"type": "https",
"encoding": "gzip",
"https_config": {
"uri": "https://siem.company.com/api/events",
"ignore_ssl_errors": false
}
},
{
"id": "dest-456",
"name": "Analytics Platform",
"description": "Data analytics and reporting platform",
"format": "json",
"type": "https",
"encoding": "encoding_unspecified",
"https_config": {
"uri": "https://analytics.company.com/webhook",
"ignore_ssl_errors": false
}
}
],
"errors": []
}